sourceInputCompletionHook: init #104225

jonringer · 2020-11-18T23:30:38Z

Motivation for this change

It's been a recurrent theme that there's some pain with nix-shell and bringing in some tools, only to have shell completion not work without adding additional code to shellHook. This solves that! (at least for bash)

This hasn't been tested with zsh or fish, as running nix-shell even with those shells will drop me into a bash shell.

If this does get added, may have it added to mkShell by default, as that's likely intended user behavior.

Also, I don't feel strongly about the name, if anyone can come up with a better name, I'll gladly change it.

example scenario:

$ kubectl
The program ‘kubectl’ is currently not installed. It is provided by
several packages. You can install it by typing one of the following:
  nix-env -iA nixos.kubectl
  nix-env -iA nixos.kubernetes
  nix-env -iA nixos.openshift
$ cat shell.nix
with import ./. { };

mkShell rec {
  buildInputs = [
    exa
    kubectl
    hyperfine
    sourceInputCompletionHook
  ];
}

$ nix-shell
Completions added for: kubectl hyperfine exa

[nix-shell:/home/jon/projects/nixpkgs]$ kubectl <tab><tab>
alpha          auth           convert        diff           get            plugin         scale          wait
annotate       autoscale      cordon         drain          kustomize      port-forward   set
api-resources  certificate    cp             edit           label          proxy          taint
api-versions   cluster-info   create         exec           logs           replace        top
apply          completion     delete         explain        options        rollout        uncordon
attach         config         describe       expose         patch          run            version

Things done

zowoq · 2020-11-18T23:33:52Z

Looks like #103501 is related?

jonringer · 2020-11-18T23:39:59Z

definitely looks related, but need to verify if the completions actually work. For stdenv, there's really no need to add shell completion, so I would be suprised if it was sourcing shell completion for normal nix builds.

nixos-discourse · 2020-11-19T00:20:35Z

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/setup-bash-completion-when-running-under-nix-shell-on-macosx/5216/6

nixos-discourse · 2020-11-19T00:21:20Z

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/shell-nix-load-completions/8803/15

jonringer · 2020-11-19T00:24:30Z

One thing of note, is that the other PR affects how XDG_DATA_DIRS works fundamentally with stdenv. While this only adds new behavior when included. (and I'll open another PR to add this to mkShell, if we feel like going in this direction)

jonringer · 2020-11-19T00:24:52Z

cc @FRidh @zimbatm on opinions

jonringer · 2020-11-19T00:28:56Z

I will have to revisit this for fish, as it's not compatible syntax

and zsh doesn't like my associative arrays

FRidh · 2020-11-19T08:49:20Z

pkgs/top-level/all-packages.nix

@@ -161,6 +161,8 @@ in
    deps = [ innoextract file-rename ]; }
    ../build-support/setup-hooks/gog-unpack.sh;

+  sourceInputCompletionHook = callPackage ../shells/hooks/sourceInputCompletionHook { };


explicitly state ShellHook?

SuperSandro2000 · 2020-11-19T09:21:43Z

pkgs/shells/hooks/sourceInputCompletionHook/source-input-completion-hook.sh

+            exit 0
+    esac


Suggested change

exit 0

esac

exit 0

;;

esac

SuperSandro2000 · 2020-11-19T09:23:28Z

Also, I don't feel strongly about the name, if anyone can come up with a better name, I'll gladly change it.

What about sourceShellCompletionHook?

roberth · 2020-11-19T09:25:47Z

pkgs/shells/hooks/sourceInputCompletionHook/source-input-completion-hook.sh

+        local completionDir=$input/$completionPath
+        if [ -d $completionDir ]; then
+            for script in $(@findutils@/bin/find $completionDir -type f); do
+                . $script


Bash completions should be loaded lazily. This can be achieved with XDG_DATA_DIRS via #103501 or if that's too radical, a shell hook.

Yea, I'm thinking of closing this in favor of #103501 . Made this PR before I was aware of it's existence

jonringer · 2020-11-19T22:59:23Z

I'm likely to close this in favor of #103501 . The other PR encourages better behavior by having individuals listing their dependencies in the appropriate nativeBuildInputs attr. I will instead just try to update example to use nativeBuildInputs instead of buildInputs

jonringer · 2021-01-11T20:32:04Z

on master:

$ nix-shell -E 'with import ./. {}; mkShell { nativeBuildInputs = [ kubectl ]; }'
these paths will be fetched (7.96 MiB download, 41.76 MiB unpacked):
  /nix/store/hzpna3nl2pq784kxj6582jcbhj6ja12j-kubectl-1.19.5
copying path '/nix/store/hzpna3nl2pq784kxj6582jcbhj6ja12j-kubectl-1.19.5' from 'https://cache.nixos.org'...

[nix-shell:~/projects/nixpkgs]$ kubectl
alpha          auth           convert        diff           get            plugin         scale          wait
annotate       autoscale      cordon         drain          kustomize      port-forward   set
api-resources  certificate    cp             edit           label          proxy          taint
api-versions   cluster-info   create         exec           logs           replace        top
apply          completion     delete         explain        options        rollout        uncordon
attach         config         describe       expose         patch          run            version

jonringer · 2021-02-11T19:15:44Z

I may open this back up again, as fish and zsh still don't have a good way to load completions.

adrian-gierakowski · 2021-02-11T19:48:20Z

@jonringer yes please!

adrian-gierakowski · 2022-05-18T18:36:18Z

Anything I can do to help revive this?

roberth · 2022-05-18T19:16:25Z

The existing and lazy solution already works for bash and fish. We can do

let pkgs = import ~/nixpkgs {}; in
pkgs.mkShell {
  packages = [ pkgs.hci pkgs.fish pkgs.zsh ];
}

and then nix-shell, use bash or invoke fish and voilà.

Zsh doesn't seem to work, but that could be for any reason, considering how sensitive scripts tend to be to their broader environment. I'm not a zsh user, so that doesn't help either.

I think the goal should be to get this to work in zsh, without introducing a worse architecture just for one shell.

adrian-gierakowski · 2022-05-18T19:45:06Z

Thanks @roberth! I’ll try this out.

sukhmel · 2023-06-15T21:10:05Z

I came upon this PR searching for some way to troubleshoot what's going on with completions in my shells, namely bash and zsh.

What I get right now is XDG_BASE_DIRS being correctly populated with /share contents, but bash refusing to load that completions at all. With zsh it seems like I'd need to also reload completions somehow, could you hint if it is possible already and what is the current state of affairs with this PR?

sourceInputCompletionHook: init

409a3b3

ofborg bot added 8.has: package (new) This PR adds a new package 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 1-10 10.rebuild-linux: 1 labels Nov 19, 2020

FRidh reviewed Nov 19, 2020

View reviewed changes

SuperSandro2000 reviewed Nov 19, 2020

View reviewed changes

roberth reviewed Nov 19, 2020

View reviewed changes

jonringer closed this Jan 11, 2021

jonringer deleted the add-source-input-completion-hook branch September 28, 2024 17:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

sourceInputCompletionHook: init #104225

sourceInputCompletionHook: init #104225

jonringer commented Nov 18, 2020 •

edited

Loading

zowoq commented Nov 18, 2020

jonringer commented Nov 18, 2020 •

edited

Loading

nixos-discourse commented Nov 19, 2020

nixos-discourse commented Nov 19, 2020

jonringer commented Nov 19, 2020

jonringer commented Nov 19, 2020

jonringer commented Nov 19, 2020 •

edited

Loading

FRidh Nov 19, 2020

SuperSandro2000 Nov 19, 2020

SuperSandro2000 commented Nov 19, 2020

roberth Nov 19, 2020

jonringer Nov 19, 2020

jonringer commented Nov 19, 2020 •

edited

Loading

jonringer commented Jan 11, 2021

jonringer commented Feb 11, 2021

adrian-gierakowski commented Feb 11, 2021

adrian-gierakowski commented May 18, 2022

roberth commented May 18, 2022

adrian-gierakowski commented May 18, 2022

sukhmel commented Jun 15, 2023

-            exit 0
-    esac
+            exit 0
+            ;;
+    esac

sourceInputCompletionHook: init #104225

sourceInputCompletionHook: init #104225

Conversation

jonringer commented Nov 18, 2020 • edited Loading

Motivation for this change

Things done

zowoq commented Nov 18, 2020

jonringer commented Nov 18, 2020 • edited Loading

nixos-discourse commented Nov 19, 2020

nixos-discourse commented Nov 19, 2020

jonringer commented Nov 19, 2020

jonringer commented Nov 19, 2020

jonringer commented Nov 19, 2020 • edited Loading

FRidh Nov 19, 2020

Choose a reason for hiding this comment

SuperSandro2000 Nov 19, 2020

Choose a reason for hiding this comment

SuperSandro2000 commented Nov 19, 2020

roberth Nov 19, 2020

Choose a reason for hiding this comment

jonringer Nov 19, 2020

Choose a reason for hiding this comment

jonringer commented Nov 19, 2020 • edited Loading

jonringer commented Jan 11, 2021

jonringer commented Feb 11, 2021

adrian-gierakowski commented Feb 11, 2021

adrian-gierakowski commented May 18, 2022

roberth commented May 18, 2022

adrian-gierakowski commented May 18, 2022

sukhmel commented Jun 15, 2023

jonringer commented Nov 18, 2020 •

edited

Loading

jonringer commented Nov 18, 2020 •

edited

Loading

jonringer commented Nov 19, 2020 •

edited

Loading

jonringer commented Nov 19, 2020 •

edited

Loading